Отмена заказа

Для отмены используется state - правило отмены, возвращаемое запросом Информация о заказе.

Синтаксис запроса

POST http://b2b-api.go.yandex.ru/integration/2.0/orders/cancel?order_id={идентификатор заказа}

Заголовки запроса

• Authorization: Bearer <OAuth-токен>
  Процесс получения токена описан в разделе Начало работы.

• X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

• Accept-Language — выбор языка в формате строки (ru, en, fr, hy, he и т.п.).

Параметры запроса

Запрос содержит обязательный параметр:

• order_id — идентификатор отменяемого заказа.

Тело запроса

Данные об отмене заказа передаются в формате JSON:

Описание полей ответа

В ответе содержится поле:

Пример запроса

POST http://b2b-api.go.yandex.ru/integration/2.0/orders/cancel?order_id=191...280
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

  {
    "state": "free"
  }

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "status": "cancelled"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

• 200 — запрос выполнен успешно.
• 400 — запросе был передан неизвестный параметр или параметр с недопустимым значением.
• 403:
  • SELECT_CLIENT_HEADER_REQUIRED — в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
  • SELECTED_CLIENT_ACCESS_DENIED — в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
• 404 — заказ не найден.
• 409 — произошел конфликт.